<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>common_util: src/common_util/filetype.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">common_util<span id="projectnumber">&#160;1.1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_2961cad218251a7c35c6867350b80887.html">common_util</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle"><div class="title">filetype.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Define the structs about fileutil, such as filetype and file_entity.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;vector&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
</div>
<p><a href="filetype_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcutl_1_1file__entity.html">cutl::file_entity</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">file entity struct. include file type and file path.  <a href="structcutl_1_1file__entity.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a4fc4cd499e8fa84c01f6288b737d619e" id="r_a4fc4cd499e8fa84c01f6288b737d619e"><td class="memItemLeft" align="right" valign="top"><a id="a4fc4cd499e8fa84c01f6288b737d619e" name="a4fc4cd499e8fa84c01f6288b737d619e"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><b>cutl::filevec</b> = std::vector&lt; <a class="el" href="structcutl_1_1file__entity.html">file_entity</a> &gt;</td></tr>
<tr class="memdesc:a4fc4cd499e8fa84c01f6288b737d619e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The vector of <a class="el" href="structcutl_1_1file__entity.html" title="file entity struct. include file type and file path.">file_entity</a>. <br /></td></tr>
<tr class="separator:a4fc4cd499e8fa84c01f6288b737d619e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a9d3ee53b2774c37cc5a17766507de28c" id="r_a9d3ee53b2774c37cc5a17766507de28c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28c">cutl::filetype</a> { <br />
&#160;&#160;<a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28ca236f879cb9a7c7b2fd492501b37b93df">cutl::ft_unknown</a> = 0x00
, <a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28caf6f3afe53ce3b3e5fa9b13ecb2fa6d29">cutl::ft_directory</a> = 0x01
, <a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28ca73832a550c08856f1067f13b5ed85363">cutl::ft_file</a> = 0x02
, <a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28cada2237cf113c873ff3f7710ba06a49a0">cutl::ft_symlink</a> = 0x04
, <br />
&#160;&#160;<a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28cad4df65ccafc9d843a5b4769c17c3ea62">cutl::ft_char_special</a> = 0x08
, <a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28ca9a2f5ff5abd682b09d08610253688fe2">cutl::ft_block_special</a> = 0x10
, <a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28caf97d9741dd387e2ee72450917407a438">cutl::ft_pipefifo</a> = 0x20
, <a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28ca22954943ada9cb745f8951241e31cc2a">cutl::ft_socket</a> = 0x40
, <br />
&#160;&#160;<a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28ca651f8df69e1132444ab2b8e033e575c5">cutl::ft_all</a> = 0xFF
<br />
 }</td></tr>
<tr class="memdesc:a9d3ee53b2774c37cc5a17766507de28c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The type of file.  <a href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28c">More...</a><br /></td></tr>
<tr class="separator:a9d3ee53b2774c37cc5a17766507de28c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a7c0e573c7e0cd198d3119f6c41afe740" id="r_a7c0e573c7e0cd198d3119f6c41afe740"><td class="memItemLeft" align="right" valign="top"><a id="a7c0e573c7e0cd198d3119f6c41afe740" name="a7c0e573c7e0cd198d3119f6c41afe740"></a>
constexpr int&#160;</td><td class="memItemRight" valign="bottom"><b>cutl::MAX_PATH_LEN</b> = 1024</td></tr>
<tr class="memdesc:a7c0e573c7e0cd198d3119f6c41afe740"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constants value: max path length. <br /></td></tr>
<tr class="separator:a7c0e573c7e0cd198d3119f6c41afe740"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Define the structs about fileutil, such as filetype and file_entity. </p>
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (c) 2024, Spencer.Luo. All Rights Reserved.</dd></dl>
<p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at </p><pre class="fragment">  http://www.apache.org/licenses/LICENSE-2.0
</pre><p> Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations.</p>
<dl class="section author"><dt>Author</dt><dd>spencer.luo </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2024-05-13 </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a9d3ee53b2774c37cc5a17766507de28c" name="a9d3ee53b2774c37cc5a17766507de28c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d3ee53b2774c37cc5a17766507de28c">&#9670;&#160;</a></span>filetype</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="filetype_8h.html#a9d3ee53b2774c37cc5a17766507de28c">cutl::filetype</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The type of file. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9d3ee53b2774c37cc5a17766507de28ca236f879cb9a7c7b2fd492501b37b93df" name="a9d3ee53b2774c37cc5a17766507de28ca236f879cb9a7c7b2fd492501b37b93df"></a>ft_unknown&#160;</td><td class="fielddoc"><p>undefined </p>
</td></tr>
<tr><td class="fieldname"><a id="a9d3ee53b2774c37cc5a17766507de28caf6f3afe53ce3b3e5fa9b13ecb2fa6d29" name="a9d3ee53b2774c37cc5a17766507de28caf6f3afe53ce3b3e5fa9b13ecb2fa6d29"></a>ft_directory&#160;</td><td class="fielddoc"><p>directory </p>
</td></tr>
<tr><td class="fieldname"><a id="a9d3ee53b2774c37cc5a17766507de28ca73832a550c08856f1067f13b5ed85363" name="a9d3ee53b2774c37cc5a17766507de28ca73832a550c08856f1067f13b5ed85363"></a>ft_file&#160;</td><td class="fielddoc"><p>regular file </p>
</td></tr>
<tr><td class="fieldname"><a id="a9d3ee53b2774c37cc5a17766507de28cada2237cf113c873ff3f7710ba06a49a0" name="a9d3ee53b2774c37cc5a17766507de28cada2237cf113c873ff3f7710ba06a49a0"></a>ft_symlink&#160;</td><td class="fielddoc"><p>symbolic link </p>
</td></tr>
<tr><td class="fieldname"><a id="a9d3ee53b2774c37cc5a17766507de28cad4df65ccafc9d843a5b4769c17c3ea62" name="a9d3ee53b2774c37cc5a17766507de28cad4df65ccafc9d843a5b4769c17c3ea62"></a>ft_char_special&#160;</td><td class="fielddoc"><p>character device, only for unix </p>
</td></tr>
<tr><td class="fieldname"><a id="a9d3ee53b2774c37cc5a17766507de28ca9a2f5ff5abd682b09d08610253688fe2" name="a9d3ee53b2774c37cc5a17766507de28ca9a2f5ff5abd682b09d08610253688fe2"></a>ft_block_special&#160;</td><td class="fielddoc"><p>block device, only for unix </p>
</td></tr>
<tr><td class="fieldname"><a id="a9d3ee53b2774c37cc5a17766507de28caf97d9741dd387e2ee72450917407a438" name="a9d3ee53b2774c37cc5a17766507de28caf97d9741dd387e2ee72450917407a438"></a>ft_pipefifo&#160;</td><td class="fielddoc"><p>named pipe, only for unix </p>
</td></tr>
<tr><td class="fieldname"><a id="a9d3ee53b2774c37cc5a17766507de28ca22954943ada9cb745f8951241e31cc2a" name="a9d3ee53b2774c37cc5a17766507de28ca22954943ada9cb745f8951241e31cc2a"></a>ft_socket&#160;</td><td class="fielddoc"><p>socket file, only for unix </p>
</td></tr>
<tr><td class="fieldname"><a id="a9d3ee53b2774c37cc5a17766507de28ca651f8df69e1132444ab2b8e033e575c5" name="a9d3ee53b2774c37cc5a17766507de28ca651f8df69e1132444ab2b8e033e575c5"></a>ft_all&#160;</td><td class="fielddoc"><p>type mask, includes all types </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
